home *** CD-ROM | disk | FTP | other *** search
/ The PC-SIG Library 10 / The PC-Sig Library - Shareware for the IBM PC and Compatibles (PC-SIG)(Tenth Edition Disks 1-2804)(1991).iso / PC_SIGCD / 03 / 8 / DISK0386.ZIP / PKARC.DOC < prev    next >
Text File  |  1986-10-23  |  18KB  |  532 lines
  1. PKARC  FAST!  Archive Create/Update Utility  Version 1.2  10-23-86  Page 1
  2.  
  3.  
  4.  
  5.  
  6.                         Table of Contents
  7.                         -----------------
  8.  
  9.  
  10.  Topic                                                 Page
  11.  -----                                                 ----
  12.  
  13.    Features and Overview .............................. 2
  14.  
  15.    Archive Functions
  16.        Add files to an archive ........................ 3
  17.        Update files to an archive ..................... 4
  18.        Freshen files in an archive .................... 4
  19.        Move files to an archive ....................... 4
  20.        Delete files in an archive ..................... 5
  21.        Verbose listing of files in an archive ......... 5
  22.  
  23.    PKARC Archive Commenting Feature ................... 6
  24.  
  25.    Using a Ramdisk with PKARC ......................... 8
  26.  
  27.    Using PKARC in a batch file ........................ 8
  28.  
  29.    PKARC Error Messages ............................... 9
  30.   
  31.    PKARC Revision history ............................. 11
  32.  
  33.    General Information ................................ 12
  34.  
  35.    Software License ................................... 12
  36.  
  37. PKARC  FAST!  Archive Create/Update Utility  Version 1.2  10-23-86  Page 2
  38.  
  39.  
  40.  
  41. Features
  42. --------
  43.  
  44.   - THE FASTEST CREATION AND UPDATING OF ARCHIVES - EVER.
  45.  
  46.   - Higher compression ratios with state-of-the-art Enhanced
  47.     Ziv-Lempel-Welch Crunching.
  48.  
  49.   - Unique Archive Commenting capability.
  50.  
  51.   - Data integrity ensured by 16 bit Cyclic Redundancy Check.
  52.  
  53.   - Superior file buffering.
  54.  
  55.   - Not copy protected.
  56.  
  57.   - Pay only if you find the software useful.
  58.  
  59.  
  60. Overview
  61. --------
  62.  
  63. An archive is a collection of one or more files  collected  into  a
  64. single  archive file.  An file extension of .ARC is usually used to
  65. denote an archive.  Each file in an archive is compressed  to  save
  66. disk  space,  backup storage space, and file transfer time.  When a
  67. file is archived, it is  analyzed  and  compressed  with  the  most
  68. optimal  data  compression  method for that file.  Every file in an
  69. archive is stored with a 16-bit Cyclic Redundancy  Check  (CRC)  to
  70. ensure data integrity when the file is extracted from the archive.
  71.  
  72. PKARC is a FAST!   archive  update/create  utility  that  generates 
  73. archives.   It  is  completely  compatible with SEAware's (Software 
  74. Enhancement Associate's)  ARC program  and  my  own  FAST!  archive 
  75. extraction  utility PKXARC, but is many times faster than SEAware's 
  76. ARC program and faster  than  ANY  OTHER  archive  utility.   PKARC 
  77. achieves  its  speed  through  the use of highly optimized assembly 
  78. language code and advanced file buffering techniques.  With version 
  79. 1.1  of  PKARC, an Enhanced Ziv-Lempel-Welch crunching technique is 
  80. employed which can result in an upto a 40% space savings over  ARC.  
  81. All archives created with PKARC can be extracted with SEAware's ARC 
  82. program or PKXARC.  Of course, PKXARC can  extract  files  from  an 
  83. archive many times faster than SEAware's ARC program.
  84.  
  85. PKARC  FAST!  Archive Create/Update Utility  Version 1.2  10-23-86  Page 3
  86.  
  87.  
  88.  
  89. Using PKARC
  90. -----------
  91.  
  92. Usage: PKARC options archive [filespec...]
  93.  
  94. Options are:
  95.       a = add files to archive       d = delete files from archive
  96.       f = freshen files in archive   m = move files to archive
  97.       u = update files in archive    v = display verbose listing of archive
  98.       l = display software license   c = add/update file comments
  99.       x = add/update archive comment
  100.  
  101. The  A,F,M,  and U options can be followed by a C and/or X to cause 
  102. prompting for the file comments and/or the archive comment.  The  V 
  103. option  can  be followed by a C for a verbose listing with the file 
  104. comments.
  105.  
  106. The DOS wildcards * and ? can be used when specifying file names.
  107.  
  108.  
  109. Adding files to an archive
  110. --------------------------
  111.  
  112. This  option is used to add files to an existing archive, or create 
  113. a new archive with the specified files.  This is  the  most  common 
  114. use  of  PKARC.  If no list of files is given, all the files in the 
  115. current directory will be added.  Examples:
  116.  
  117. PKARC a stuff
  118.  
  119. will collect all the files in the current directory, and place them 
  120. in the archive STUFF.ARC
  121.  
  122. PKARC a a:manuals b:*.doc b:*.txt
  123.  
  124. will collect all files with an extension of .DOC or .TXT on drive B 
  125. and place them in the archive A:MANUALS.ARC.
  126.  
  127. PKARC  FAST!  Archive Create/Update Utility  Version 1.2  10-23-86  Page 4
  128.  
  129.  
  130.  
  131. Updating files to an archive
  132. ----------------------------
  133.  
  134. This option works the same as the Add option,  with  the  exception 
  135. that if a file already exists within an archive, it will be updated 
  136. only if the datestamp of the file on the disk is  dated  after  the 
  137. file  within  the  archive.   This option can be used to prevent an 
  138. earlier version of a file from overwriting a later version which is 
  139. in an archive.  For example:
  140.  
  141. PKARC u manuals *.doc *.txt
  142.  
  143. will  collect all files with an extension of .DOC or .TXT and place 
  144. them in the archive MANUALS.ARC.  If however, a file already exists 
  145. in  the  archive  and  on  the  disk  (say  STARTREK.DOC), the file 
  146. STARTREK.DOC will be added to the archive only if it is dated later 
  147. than  the  version already in the archive.  If the file on the disk 
  148. has an earlier date, then the version in the archive will remain.
  149.  
  150.  
  151. Freshening files in an archive
  152. ------------------------------
  153.  
  154. This option is used to ensure that  an  archive  contains  all  the 
  155. latest  versions of its files.  The Freshen function works like the 
  156. Update function, except it will not cause new files to be added  to 
  157. the archive.  For example:
  158.  
  159. PKARC f arcutil b:*.*
  160.  
  161. will  go  through  all the files on drive B and look for files that 
  162. are in already in the archive, but with a later date.  If  a  later 
  163. version is found, it will be updated in the archive.
  164.  
  165.  
  166. Moving files to an archive
  167. --------------------------
  168.  
  169. This option works exactly like the Add function,  except  that  the 
  170. original   files   are  deleted  from  the  disk  after  successful 
  171. archiving.  The files are deleted only after the archive is created 
  172. and  completed,  and  no errors have occurred.  If any errors occur 
  173. during the archiving process (such as disk full) the original files 
  174. will not be deleted.  For example:
  175.  
  176. PKARC m cfiles *.c
  177.  
  178. will add all files with an extension .C to the archive  CFILES.ARC.  
  179. After  all  the  files have been successfully added to the archive, 
  180. they will be deleted from the disk.
  181.  
  182. PKARC  FAST!  Archive Create/Update Utility  Version 1.2  10-23-86  Page 5
  183.  
  184.  
  185.  
  186. Deleting files from an archive
  187. ------------------------------
  188.  
  189. This option is used to delete files from within an archive.  For 
  190. example:
  191.  
  192. PKARC d games *.bas
  193.  
  194. This will delete all files with the extension .BAS from the archive 
  195. GAMES.ARC.
  196.  
  197.  
  198. Verbose listing of an archive
  199. -----------------------------
  200.  
  201. This option is used to list the contents of an archive.  The 
  202. listing is in the following format:
  203.  
  204. Filename        Length   Method     Size   Ratio    Date      Time
  205. --------        ------   ------    ------  -----    ----      ----
  206. FILENAME.EXT    nnnnnn  aaaaaaaa   nnnnnn   nn%   mm-dd-yy  hr-mm-ss
  207.  
  208. The length is the true length of the file.  The method is the  data 
  209. compression technique used on the file and is one of the following:
  210.  
  211. Stored    The file was Stored.
  212. Packed    The file was Packed with non-repeat packing.
  213. crunched  The file was crunched with old sytle Ziv-Lempel-Welch compression.
  214. Crunched  The file was Crunched with Dynamic Ziv-Lempel-Welch compression.
  215. Squeezed  The file was Squeezed with Huffman encoding.
  216.  
  217. The  size  is the resulting size of the file after compression, and 
  218. the ratio is the percentage of file space saved.   For  example,  a 
  219. file  with  a  length  of  10,000  and a size of 2,500 would have a 
  220. savings ratio of 75%.
  221.  
  222. PKARC  FAST!  Archive Create/Update Utility  Version 1.2  10-23-86  Page 6
  223.  
  224.  
  225.  
  226. PKARC Archive File Comments Feature
  227. -----------------------------------
  228.  
  229. One  of  the  unique  features  of  PKARC is the ability to store a 
  230. comment with an archive, and optionally a comment for each file  in 
  231. an archive, similar to the file descriptions found on many Bulletin 
  232. Board Systems.  The archive comment is automatically displayed when 
  233. the archive is manipulated by PKARC version 1.2 or later and PKXARC 
  234. version 3.3 or later.  Each file in  an  archive  can  be  given  a 
  235. comment  which  can be displayed with the verbose listing function.  
  236.  
  237. Following the V option with letter C will cause the comments to  be 
  238. displayed.  For example:
  239.  
  240. PKARC vc utility
  241.  
  242. will display the files in the archive UTILITY.ARC with the archive 
  243. file comments in the following format:
  244.  
  245. Filename        Comment                             Date      Time
  246. --------        --------------------------------    ----      ----
  247. FILENAME.EXT    cccccccccccccccccccccccccccccccc  mm-dd-yy  hr-mm-ss
  248.  
  249. The  archive comment and file comments can be upto 32 characters in 
  250. length.
  251.  
  252. If the A,U,F, or M options are followed  by  a  X,  prompting  will 
  253. occur for the archive comment.  For example:
  254.  
  255. PKARC ax datafils *.dat
  256.  
  257. will   add  all  files  with  an  extension  .DAT  to  the  archive 
  258. DATAFILS.ARC and prompt for the archive comment for DATAFILS.ARC.
  259.  
  260. If  the  A,U,F,  or  M  options are followed by a C, prompting will 
  261. occur for a file comment after each file is added to  the  archive.  
  262. For example:
  263.  
  264. PKARC ac datafils *.dat
  265.  
  266. will   add  all  files  with  an  extension  .DAT  to  the  archive 
  267. DATAFILS.ARC.  After each file is  placed  into  the  archive,  the 
  268. comment for that file can be entered.
  269.  
  270. The  C  and  X options from above can be combined to prompt for the 
  271. archive comment and the  file  comments  at  the  same  time.   For 
  272. example:
  273.  
  274. PKARC acx datafils *.dat
  275.  
  276. will  add  all  files  with  an  extension  .DAT  to  the   archive 
  277. DATAFILS.ARC  and  cause  prompting for the archive comment and the 
  278. file comments.
  279.  
  280. PKARC  FAST!  Archive Create/Update Utility  Version 1.2  10-23-86  Page 7
  281.  
  282.  
  283.  
  284. The  C  option  can  be  used  to add or update file comments.  For 
  285. example:
  286.  
  287. PKARC c programs
  288.  
  289. will go through all files in the archive  PROGRAMS.ARC  and  prompt 
  290. for  a comment for each file.  Comments can be updated selectively, 
  291. such as:
  292.  
  293. PKARC c programs spoolkey.sys
  294.  
  295. will allow the file comment for the specified file to be  added  or 
  296. changed.
  297.  
  298. The X option can be used to add or update the archive comment.  For 
  299. example:
  300.  
  301. PKARC x programs
  302.  
  303. will add or update the archive comment for the archive PROGRAMS.ARC.
  304.  
  305. The  C  and  X options from above can be combined to prompt for the 
  306. archive comment and the  file  comments  at  the  same  time.   For 
  307. example:
  308.  
  309. PKARC cx programs
  310.  
  311. will add or update the archive comment and the  file  comments  for 
  312. the archive PROGRAMS.ARC.
  313.  
  314. PKARC  FAST!  Archive Create/Update Utility  Version 1.2  10-23-86  Page 8
  315.  
  316.  
  317.  
  318. NOTE: The  comments  are  stored  in  a  way totally transparent to 
  319.       SEAware's ARC program and and have no effect on the operation 
  320.       of ARC.
  321.  
  322.       However,  because  SEAware's  ARC program does not know about 
  323.       archive comments or file comments, ARC truncates the comments 
  324.       from  an  archive  when  modifying  it.   Using SEAware's ARC 
  325.       program to add, update, move, freshen or delete files from an 
  326.       archive  will  cause all comments to be lost.  If you wish to 
  327.       retain the comments within an archive, it is recommended that 
  328.       the use of SEAware's ARC program be avoided.
  329.  
  330.  
  331. Using a Ramdisk with PKARC
  332. --------------------------
  333.  
  334. PKARC sometimes creates one or two temporary files while  archiving 
  335. files.  The default drive for these files is the current drive.  In 
  336. order to increase performance, PKARC can be told which drive and/or 
  337. subdirectory  to  use  for  temporary files through DOS environment 
  338. strings.   PKARC  searches   the   environment   for   the   string 
  339. PKARCTMP=pathspec.    For   compatibility   with  ARC,  the  string 
  340. ARCTEMP=pathspec can be used as well.  For example if drive D is  a 
  341. ramdisk, entering:
  342.  
  343. SET PKARCTMP=D:
  344.  
  345. at the DOS prompt will cause PKARC to use  drive  D  for  temporary 
  346. files.
  347.  
  348.  
  349. Using PKARC in a batch file
  350. ---------------------------
  351.  
  352. If you are using PKARC from a batch file, you  can  test  if  PKARC 
  353. aborted  with  an  error  using the DOS errorlevel variable.  PKARC 
  354. returns a non-zero errorlevel if an  error  occurred,  and  a  zero 
  355. errorlevel for normal termination.  
  356.  
  357. PKARC  FAST!  Archive Create/Update Utility  Version 1.2  10-23-86  Page 9
  358.  
  359.  
  360.  
  361. PKARC Error Messages
  362. --------------------
  363.  
  364. When  any  of the following errors are detected, PKARC will display 
  365. the indicated message and abort to DOS.   All  original  files  and 
  366. archives  will  be  intact,  as  PKARC does not overwrite or delete 
  367. existing files on the disk until the entire archive processing  has 
  368. been  successfully  completed.
  369.  
  370.  
  371. PKARC: Unknown option: (unknown character)
  372.  
  373.     The displayed option is unknown.
  374.  
  375. PKARC: Insufficient Memory
  376.  
  377.     There is not enough free memory to run PKARC.
  378.  
  379. PKARC: No archive specified.
  380.  
  381.     The name of the archive to be processed must be given.
  382.  
  383. PKARC: No files specified for deletion.
  384.  
  385.     The delete option was  specified,  but  no  files  were  given. 
  386.     Unlike other options, delete does not assume *.* if no specific 
  387.     files are given.
  388.  
  389. PKARC: Can't find XXXXXXXX.YYY
  390.  
  391.     The specified file(s) could not be found.
  392.  
  393. PKARC: No file(s) found.
  394.  
  395.     No files were found to add or update to the archive.
  396.  
  397. PKARC: Can't create file XXXXXXXX.YYY
  398.  
  399.     The displayed file could not be created.  The output directory 
  400.     is probably invalid or full.
  401.  
  402. PKARC: Too Many Files.
  403.  
  404.     This error will occur if more than 512 files  or  16  different 
  405.     drive/pathspecs  are  given  at  one  time for the add, update, 
  406.     freshen, or move options.
  407.  
  408. PKARC  FAST!  Archive Create/Update Utility  Version 1.2  10-23-86  Page 10
  409.  
  410.  
  411.  
  412. PKARC: XXXXXXXX.YYY is not an archive.
  413.  
  414.     The archive name given to PKARC existed on the disk, but either 
  415.     is not an archive, or is corrupted.
  416.  
  417. PKARC: Can't open XXXXXXXX.YYY
  418.  
  419.     The displayed file could not be opened.
  420.  
  421. PKARC: disk full
  422.  
  423.     The disk is full.
  424.  
  425. PKARC  FAST!  Archive Create/Update Utility  Version 1.2  10-23-86  Page 11
  426.  
  427.  
  428.  
  429. PKARC Revision History
  430. ----------------------
  431.  
  432. *** PKARC version 1.0, 8-06-86 ***
  433.  
  434. Initial release.
  435.  
  436.  
  437. *** PKARC version 1.1, 9-12-86 ***
  438.  
  439. Enhanced  Ziv-Lempel-Welch  compression  was  added  to PKARC.  The 
  440. enchanced crunching algorithm provides superior compression  ratios 
  441. over  the  traditional  crunching  algorithm  used in SEAware's ARC 
  442. program.  Files crunched with the enhanced crunching algorithm  are 
  443. up to 40% smaller, yet still fully compatible with ARC and PKXARC.
  444.  
  445. File buffering has been drastically improved, resulting in faster 
  446. compression, especially on floppy disks.
  447.  
  448. The improved buffering and other optimizations  have resulted  in  a 
  449. twofold increase in archiving speed over PKARC version 1.0. 
  450.  
  451.  
  452. *** PKARC version 1.2, 10-23-86 ***
  453.  
  454. PKARC  version  1.1  inadvertently  introduced a rare bug involving 
  455. squeezed files.  This has been corrected in version 1.2.
  456.  
  457. Archive commenting ability has been  added  to  PKARC.   PKARC  now 
  458. allows  a comment to be assigned to an archive, in addition to each 
  459. file within an  archive.   The  archive  comment  is  automatically 
  460. displayed  when  the archive is manipulated by PKARC version 1.2 or 
  461. later and PKXARC version 3.3 or later.
  462.  
  463. File  buffering  has  been improved.  While PKARC will still run in 
  464. minimum of 128K of RAM, PKARC will take advantage of upto  224K  of 
  465. RAM if available to increase file buffering.
  466.  
  467. The   Enhanced   Ziv-Lempel-Welch  compression  has  been  slightly 
  468. improved.  Some files will compress upto 5% smaller than with PKARC 
  469. version 1.1.  Binary files should experience the most improvement.
  470.  
  471. Optimizations  in  PKARC  version  1.2  have resulted in upto a 20% 
  472. increase in archiving speed over PKARC version 1.1.
  473.  
  474. PKARC  FAST!  Archive Create/Update Utility  Version 1.2  10-23-86  Page 12
  475.  
  476.  
  477.  
  478. General Information
  479. -------------------
  480.  
  481. PKARC will run on any  IBM  PC/XT/AT/RT/jr/Portable/Convertible  or 
  482. DOS  compatible  whatever  running  PC/MS-DOS  2.0 or higher with a 
  483. minimum of 128K free RAM.
  484.  
  485. IBM is a registered trademark of the International Business Machine
  486. Corporation.
  487. MS-DOS is a registered trademark of Microsoft Inc.
  488.  
  489. If you have any questions or comments about PKARC send them to:
  490.  
  491. Phil Katz
  492. Exec-PC multi-user IBM BBS (16 lines, 24 hours a day)
  493. Milwaukee, WI
  494. (modem) (414) 964-5160
  495.  
  496. Special thanks to Bob Mahoney, SYSOP of Exec-PC and
  497. Alan Losoff, author of ALUSQ.
  498.  
  499.  
  500. License
  501. -------
  502.  
  503. Copyright (c) 1986 PKWARE, Inc.  All Rights Reserved.
  504.  
  505. You are free to use, copy and distribute PKARC providing that:
  506.  
  507.         NO FEE IS CHARGED FOR USE, COPYING OR DISTRIBUTION.
  508.  
  509.         IT IS NOT MODIFIED IN ANY WAY.
  510.  
  511. Clubs  and  user  groups  may charge a nominal fee for expenses and 
  512. handling while distributing PKARC.
  513.  
  514. Site licenses, commercial licenses and custom versions of PKARC and 
  515. PKXARC  are  available.   Write  to  the  address  below  for  more 
  516. information.
  517.  
  518. This program is provided AS IS without any warranty,  expressed  or 
  519. implied,  including  but  not  limited  to fitness for a particular 
  520. purpose.
  521.  
  522. If you find PKARC fast, easy, and convenient to use, a contribution 
  523. of $20 would be appreciated.  With each contribution of $45 or more 
  524. you will be registered to receive a diskette with the next versions 
  525. of PKARC and PKXARC  when  available.   Please  state  the  current 
  526. versions of PKARC and PKXARC that you have.  Send contributions to:
  527.  
  528. PKWARE, Inc.
  529. 7032 Ardara Avenue
  530. Glendale, WI 53209
  531.  
  532.